Add documentation: API Reference Guide #214
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
🌿 Preview your docs: https://vapi-preview-d131eacc-f5cb-41ef-8ba4-7734b655359e.docs.buildwithfern.com |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
API Reference Guide
Introduction
This document provides a comprehensive reference for the API, detailing all available endpoints, request and response formats, parameters, and status codes. It is intended for developers and technical architects who are integrating with our API.
Endpoints Overview
This section provides a high-level overview of the available API endpoints.
/exampleGET/example/{id}GET/examplePOST/example/{id}PUT/example/{id}DELETERequest/Response Format
All API requests and responses use JSON (JavaScript Object Notation) as the data format. The
Content-Typeheader for requests should be set toapplication/json.Example Request Header: